Delete an API

What

Specific team members can delete an exisitng API.

• NOT Session-specific—Deleting an API, is not session-specific and the API that is deleted, is permanently deleted.
• NOT User-specific—The APIs are visible to all of your company’s team members who access APIs in PortX, and deleting an API affects all of your company’s team members who use or access the APIs.
• Confirmation message—A system confirmation message DOES appear in the upper right of the page, when deleting an API.

NOTE: When you delete your API, you can choose to retain any of the following parts of that API:

• Github repo
• Ecr repo
• Gitops App

Where

Where is an API deleted? Deleting an API is initiated on the API Catalog Page, then the details are entered in the Edit API page.

When

When should APIs be deleted? As needed to meet your company’s business needs.

Who

Who should delete APIs? The Team Members to whom your company has granted permission and authorized to delete APIs.

Why

Why delete an API? Delete an API as needed for your company’s business needs. Deleting unneeded APIs may reduce clutter and reduce risk of confusion of using an API that does not meet your company’s business needs.

How

How to delete an existing API? Instructions and screen captures are provided here in this section of the PortX Platform documentation.

Figure 21. Select the API to be Deleted and Open It

Find the API you want to delete. Click on the Open button as shown in Figure 21.

The Edit API page opens as shown in Figure 22.

Figure 22. The Edit API Page also has a Delete Button—Press the Delete Button

To delete the API, click on the red Delete button near the bottom of the Edit API Page.

The Confirmation Window of Items to be Deleted opens (as shown in Figure 23).

Figure 23. The Edit API Page, Delete Button—Confirmation Window of Items to be Deleted

Choose the check boxes of the items you want deleted when you delete the API (as shown in Figure 23):

• Github repo
• Ecr repo
• Gitops App

Figure 24. The Delete API Item Window—Yes Confirmation Button is Not Selectable Until Full Name of API is Entered

Enter the name of the API with its precise spelling.

The Confirmation Button of “Yes” does not appear until the full name of the API is Entered. Figure 24 shows an incomplete name and Figure 25 shows the complete name with the Yes Button for Confirmation Delete available.

Figure 25. The Delete API Item Window—Full Name of API is Entered and Yes Confirmation Button Is Selectable

Review that you are deleting the 3 check boxes if they are selected.

Click on the Yes button.

Figure 26 shows an API in process of the entire API being deleted.

Figure 26. The Delete API Page After the Delete is in Progress for All the Checkboxes, Before it is Completed

When the Delete API is complete for all the check boxes, the API is completely gone and not findable or selectable.

---